Interface SyslogServer

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
SyslogServerImpl

public interface SyslogServer extends Process
Information provided by the PKI file:

    \class SyslogServer
    
    \brief SyslogServer handles and manipulates the Syslog service.
    
    \example network().getDevice("Server0").getProcess("SyslogServer")
    
Author:
Auto-generated
  • Method Details

    • setEnable

      void setEnable(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the Syslog service.
          
          \param bEnable, true to enable the Syslog service, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • isEnabled

      boolean isEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if the Syslog service is enabled, otherwise false.
          
          \return bool, true if the Syslog service is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setPortNumber

      void setPortNumber(Short portNum)
      Information provided by the PKI file:
      
          \brief Sets the port number for the Syslog service.
          
          \param portNum, the port number for the Syslog service.
          
              
      Parameters:
      portNum - Takes in a parameter of portNum
    • getPortNumber

      Short getPortNumber()
      Information provided by the PKI file:
      
          \brief Returns the port number for the Syslog service.
          
          \return short, the port number for the Syslog service.
          
              
      Returns:
      Short Returns a Short
    • getAllEntries

      List<SyslogEntry> getAllEntries()
      Information provided by the PKI file:
      
          \brief Returns all Syslog entries.
          
          \return vector of Syslog Entry
          
              
      Returns:
      List<SyslogEntry> Returns a List<SyslogEntry>
    • clearAllSysLogEntries

      void clearAllSysLogEntries()
      Information provided by the PKI file:
      
          \brief Clear all syslog entries